Skip to main content
GET
/
brands
/
{id}
Get brand
curl --request GET \
  --url https://api.example.com/brands/{id}
{
  "data": {
    "id": "0001",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Burger Co.",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Brand landing page",
      "entity": "BRANDS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "tagline",
          "type": "TEXT",
          "label": { "en_us": "Tagline" },
          "required": false,
          "value": "Flame-grilled since 1987"
        }
      ]
    }
  }
}
Returns one brand by external id. Use this endpoint after the customer selects a brand to load its name, status, and CMS content for the storefront.
Requires a Fire spark access token obtained through token exchange.

​
Path parameters

ParameterRequiredDescription
idYesExternal brand identifier. Alphanumeric characters, _, and - only. 1–64 characters.

​
Request

curl "https://firespark.vercel.app/api/storefront/v1/brands/0001" \
  -H "Authorization: Bearer ACCESS_TOKEN"

​
Response

The response wraps a single brand object in data. The shape matches list brands. 
{
  "data": {
    "id": "0001",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Burger Co.",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Brand landing page",
      "entity": "BRANDS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "tagline",
          "type": "TEXT",
          "label": { "en_us": "Tagline" },
          "required": false,
          "value": "Flame-grilled since 1987"
        }
      ]
    }
  }
}

​
Brand fields

See list brands for the full schema, including cms_template_id and cms.
Pass the brand id in the x-brand-id header on list stores and list channels to scope results to that brand.

​
Error responses

StatusDescription
401Missing or invalid access token.
403Token does not have access to this brand.
404No brand found with the given id.